Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Typst Test Fixes #391

Merged
merged 8 commits into from
Jan 21, 2025
Merged

Typst Test Fixes #391

merged 8 commits into from
Jan 21, 2025

Conversation

grantlemons
Copy link
Collaborator

Thanks to @Andrew15-5 for suggestions on #302.

@Andrew15-5
Copy link
Contributor

(Idiomatic tests would probably be best suited by you creating a new pr though)

Bu-but you still included it in this PR. How come? Did you mean other than this one idiomatic example?

@Andrew15-5
Copy link
Contributor

Additionally, FYI, at least in GitHub (and GitLab), you can attribute/credit someone by adding this to the end of the comment body:


Co-authored-by: name <email>

https://stackoverflow.com/questions/7442112/how-to-attribute-a-single-commit-to-multiple-developers

@Andrew15-5
Copy link
Contributor

grantlemons#3

@grantlemons
Copy link
Collaborator Author

(Idiomatic tests would probably be best suited by you creating a new pr though)

Bu-but you still included it in this PR. How come? Did you mean other than this one idiomatic example?

Yes, I meant further examples, since mine was just something I cobbled together by looking at the documentation, so even the simplified version may not include things one would actually use when writing a document.

Don't feel obligated to, I'm just inviting it if you think it would be helpful.

@Andrew15-5
Copy link
Contributor

Don't feel obligated to, I'm just inviting it if you think it would be helpful.

Nah, I just want to sort out the attribution thing, since you've used my code without any credit in the commits (only in GitHub comments). Hence, #391 (comment). I also wanted to create the PR myself to directly apply my fixes. My proposal for the current state of the PR is to rebase the changes, specifically editing the commit messages of the first two commits with the attribution line I showed.

It's actually not easy for me to come up with some random examples, so I'm not sure about this. And I also feel like adding just any examples will just bloat the repo. If there are some clear guidelines, then maybe I can cook something up.

@grantlemons
Copy link
Collaborator Author

grantlemons commented Jan 16, 2025

@Andrew15-5 I've amended the commit containing your simplified document to add the Co-authored-by statement. If credit is important to you, I'm fine with letting you open your own PR if you'd like. I am just trying to be proactive in fixing the issues you highlighted.

As for coming up with examples, that's fine, I agree it's probably best not to bloat the repo.

@Andrew15-5
Copy link
Contributor

Andrew15-5 commented Jan 16, 2025

Thank you. I have another change I would like to make: grantlemons#4. Since the intent was to just simplify the existing example (and keep the same output), I not only fixed some issues with the original one (so that everything works as intended), but also made them (complex and simplified) output the same PDF file byte-by-byte (https://typst.app/docs/reference/model/document/#parameters-date).

One problem was that adding heading and just bold text result in different output, even though diffpdf says they look the same. This is because the heading also add some semantic changes to the PDF (apparently even if I add outlined: false). So I reverted it to being just a bold text.

@Andrew15-5
Copy link
Contributor

Nice. I have one last thing to discuss, as I still not understand it completely.

Assume the wrapped paragraph in file.typ:

Lorem ipsum dolor sit amet, officia excepteur ex fugiat reprehenderit enim
labore culpa sint ad nisi Lorem pariatur mollit ex esse exercitation amet. Nisi
anim cupidatat excepteur officia. Reprehenderit nostrud nostrud ipsum Lorem est
aliquip amet voluptate voluptate dolor minim nulla est proident. Nostrud
officia pariatur ut officia. Sit irure elit esse ea nulla sunt ex occaecat
reprehenderit commodo officia dolor Lorem duis laboris cupidatat officia
voluptate. Culpa proident adipisicing id nulla nisi laboris ex in Lorem sunt
duis officia eiusmod. Aliqua reprehenderit commodo ex non excepteur duis sunt
velit enim. Voluptate laboris sint cupidatat ullamco ut ea consectetur et est
culpa et culpa duis.
Output

image

As the tests show, I assume each of the adjacent lines will be separated by the Newline(1) token. But will Harper still recognize the paragraph as a single block? Because IIUC, since there is Newline between a heading and a paragraph, and it makes the Harper to spellcheck them separately, this means that all these lines will be checked separately which is not the desired behavior. #302 (comment)

@grantlemons grantlemons changed the title Typst Fixes Typst Test Fixes Jan 17, 2025
@grantlemons
Copy link
Collaborator Author

I was wrong about newlines, they don't break up sequences. That being said, that means the translator needs to be changed to use parbreaks instead of newlines for headers &c.

We've already gotten some issues with the parser, so I'm going to put together a general typst parser fixes PR to try to get those sorted. I'll include newline vs. parbreak in that.

@Andrew15-5
Copy link
Contributor

OK, so if that thing will be covered in a separate PR, then we can merge this one.

@grantlemons grantlemons mentioned this pull request Jan 20, 2025
@elijah-potter elijah-potter merged commit 567d514 into Automattic:master Jan 21, 2025
17 checks passed
@grantlemons grantlemons deleted the typst-fixes branch January 21, 2025 17:54
tmeijn pushed a commit to tmeijn/dotfiles that referenced this pull request Jan 28, 2025
This MR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [Automattic/harper/harper-ls](https://github.com/Automattic/harper) | minor | `v0.16.0` -> `v0.18.0` |

MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot).

**Proposed changes to behavior should be submitted there as MRs.**

---

### Release Notes

<details>
<summary>Automattic/harper (Automattic/harper/harper-ls)</summary>

### [`v0.18.0`](https://github.com/Automattic/harper/releases/tag/v0.18.0)

[Compare Source](Automattic/harper@v0.17.0...v0.18.0)

#### What's Changed

-   fix two grammatical errors by [@&#8203;hippietrail](https://github.com/hippietrail) in Automattic/harper#481
-   Reword description of "that which" to avoid ironic redundancy by [@&#8203;hippietrail](https://github.com/hippietrail) in Automattic/harper#479
-   feat([#&#8203;422](Automattic/harper#422)): add `same than` -> `same as` matcher trigger by [@&#8203;grantlemons](https://github.com/grantlemons) in Automattic/harper#453
-   missing definite article, comma placement by [@&#8203;hippietrail](https://github.com/hippietrail) in Automattic/harper#480
-   Improvements to `PluralConjugate` by [@&#8203;elijah-potter](https://github.com/elijah-potter) in Automattic/harper#474
-   correct Valentine's Day by [@&#8203;hippietrail](https://github.com/hippietrail) in Automattic/harper#491
-   typo in zed integration doc by [@&#8203;hippietrail](https://github.com/hippietrail) in Automattic/harper#490
-   feat(core): created linter for [#&#8203;426](Automattic/harper#426) by [@&#8203;elijah-potter](https://github.com/elijah-potter) in Automattic/harper#452
-   I missed a lets/let's mistake in a comment by [@&#8203;hippietrail](https://github.com/hippietrail) in Automattic/harper#492
-   docs: rewrote instructions on how to author a rule by [@&#8203;elijah-potter](https://github.com/elijah-potter) in Automattic/harper#482
-   missing indefinite article in comments by [@&#8203;hippietrail](https://github.com/hippietrail) in Automattic/harper#488
-   Apply rule from issue [#&#8203;465](Automattic/harper#465) to core document.rs by [@&#8203;hippietrail](https://github.com/hippietrail) in Automattic/harper#510
-   feat(core): allow trailing commas in the `lint_group` macro by [@&#8203;elijah-potter](https://github.com/elijah-potter) in Automattic/harper#483
-   fix agreement error in docs by [@&#8203;hippietrail](https://github.com/hippietrail) in Automattic/harper#417

**Full Changelog**: Automattic/harper@v0.17.0...v0.18.0

### [`v0.17.0`](https://github.com/Automattic/harper/releases/tag/v0.17.0)

[Compare Source](Automattic/harper@v0.16.0...v0.17.0)

#### What's Changed

-   feat([#&#8203;393](Automattic/harper#393)): add clap version & about attributes by [@&#8203;grantlemons](https://github.com/grantlemons) in Automattic/harper#394
-   docs: added Homebrew as an installation method by [@&#8203;elijah-potter](https://github.com/elijah-potter) in Automattic/harper#395
-   typos/spelling/grammar fixes in comments, docs, and strings by [@&#8203;hippietrail](https://github.com/hippietrail) in Automattic/harper#398
-   fix(core): harden title case module by [@&#8203;elijah-potter](https://github.com/elijah-potter) in Automattic/harper#396
-   fix(core): indexing problems by [@&#8203;elijah-potter](https://github.com/elijah-potter) in Automattic/harper#409
-   fix typo: remove extraneous 'to' by [@&#8203;hippietrail](https://github.com/hippietrail) in Automattic/harper#418
-   chore: update description of Oxford rule by [@&#8203;ccoVeille](https://github.com/ccoVeille) in Automattic/harper#419
-   build(deps): bump itertools from 0.13.0 to 0.14.0 by [@&#8203;dependabot](https://github.com/dependabot) in Automattic/harper#431
-   build(deps): bump serde_json from 1.0.135 to 1.0.137 by [@&#8203;dependabot](https://github.com/dependabot) in Automattic/harper#429
-   Typst Test Fixes by [@&#8203;grantlemons](https://github.com/grantlemons) in Automattic/harper#391
-   build(deps): bump clap from 4.5.23 to 4.5.27 by [@&#8203;dependabot](https://github.com/dependabot) in Automattic/harper#444
-   feat: Update VSCode Config by [@&#8203;mcecode](https://github.com/mcecode) in Automattic/harper#400
-   fix(core): infinite lint loops by [@&#8203;elijah-potter](https://github.com/elijah-potter) in Automattic/harper#390
-   Clean Up `harper-ls` logs by [@&#8203;elijah-potter](https://github.com/elijah-potter) in Automattic/harper#447
-   build(deps): bump undici from 6.19.8 to 6.21.1 in /packages by [@&#8203;dependabot](https://github.com/dependabot) in Automattic/harper#450
-   typo by [@&#8203;hippietrail](https://github.com/hippietrail) in Automattic/harper#462
-   fix(core): the Oxford comma applies to `nor` as well by [@&#8203;elijah-potter](https://github.com/elijah-potter) in Automattic/harper#445
-   feat(harper.js): added ability to explicitly set config to the default by [@&#8203;elijah-potter](https://github.com/elijah-potter) in Automattic/harper#449
-   build(deps-dev): bump vite from 6.0.5 to 6.0.9 in /packages by [@&#8203;dependabot](https://github.com/dependabot) in Automattic/harper#448
-   feat(core): created a  new rule that resolves [#&#8203;414](Automattic/harper#414) by [@&#8203;elijah-potter](https://github.com/elijah-potter) in Automattic/harper#455
-   build(deps-dev): bump vite from 5.4.11 to 5.4.12 in /packages by [@&#8203;dependabot](https://github.com/dependabot) in Automattic/harper#475
-   docs: added page to explain tooling for reviewers by [@&#8203;elijah-potter](https://github.com/elijah-potter) in Automattic/harper#471
-   fix instance of [#&#8203;384](Automattic/harper#384) in docs by [@&#8203;hippietrail](https://github.com/hippietrail) in Automattic/harper#477

#### New Contributors

-   [@&#8203;hippietrail](https://github.com/hippietrail) made their first contribution in Automattic/harper#398
-   [@&#8203;ccoVeille](https://github.com/ccoVeille) made their first contribution in Automattic/harper#419

**Full Changelog**: Automattic/harper@v0.16.0...v0.17.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this MR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box

---

This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4xMjYuMSIsInVwZGF0ZWRJblZlciI6IjM5LjEzNC4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJSZW5vdmF0ZSBCb3QiXX0=-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants